home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / frame.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  8.1 KB  |  303 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/frame.man,v 1.7 92/08/07 08:57:33 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS frame cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. frame \- Create and manipulate frame widgets
  193. .SH SYNOPSIS
  194. \fBframe\fI \fIpathName \fR?\fB\-class \fIclassName\fR? ?\fIoptions\fR?
  195. .SH "STANDARD OPTIONS"
  196. .LP
  197. .nf
  198. .ta 4c 8c 12c
  199. .VS
  200. \fBbackground\fR    \fBcursor\fR    \fBrelief\fR
  201. .VE
  202. \fBborderWidth\fR    \fBgeometry\fR
  203. .fi
  204. .LP
  205. See the ``options'' manual entry for details on the standard options.
  206. .SH "WIDGET-SPECIFIC OPTIONS"
  207. .LP
  208. .nf
  209. .VS
  210. Name:    \fBheight\fR
  211. Class:    \fBHeight\fR
  212. Command-Line Switch:    \fB\-height\fR
  213. .fi
  214. .IP
  215. Specifies the desired height for the window in any of the forms
  216. acceptable to \fBTk_GetPixels\fR.
  217. This option is only used if the \fB\-geometry\fR option is
  218. unspecified.
  219. If this option is less than or equal to zero (and \fB\-geometry\fR
  220. is not specified) then the window will not request any size at
  221. all.
  222. .LP
  223. .nf
  224. Name:    \fBwidth\fR
  225. Class:    \fBWidth\fR
  226. Command-Line Switch:    \fB\-width\fR
  227. .fi
  228. .IP
  229. Specifies the desired width for the window in any of the forms
  230. acceptable to \fBTk_GetPixels\fR.
  231. This option is only used if the \fB\-geometry\fR option is
  232. unspecified.
  233. If this option is less than or equal to zero (and \fB\-geometry\fR
  234. is not specified) then the window will not request any size at
  235. all.
  236. .VE
  237. .BE
  238.  
  239. .SH DESCRIPTION
  240. .PP
  241. The \fBframe\fR command creates a new window (given by the
  242. \fIpathName\fR argument) and makes it into a frame widget.
  243. Additional
  244. options, described above, may be specified on the command line
  245. or in the option database
  246. to configure aspects of the frame such as its background color
  247. and relief.  The \fBframe\fR command returns the
  248. path name of the new window.
  249. .PP
  250. A frame is a simple widget.  Its primary purpose is to act as a
  251. spacer or container for complex window layouts.  The only features
  252. of a frame are its background color and an optional 3-D border to make the
  253. frame appear raised or sunken.
  254. .PP
  255. In addition to the standard options listed above, a \fB\-class\fR
  256. option may be specified on the command line.  If it is specified, then
  257. the new widget's class will be set to \fIclassName\fR instead of
  258. \fBFrame\fR.  Changing the class of a frame widget may be useful
  259. in order to use a special class name in database options referring
  260. to this widget and its children.  Note:  \fB\-class\fR is handled
  261. differently than other command-line options and cannot be specified
  262. using the option database (it has to be processed
  263. before the other options are even looked up, since the new class
  264. name will affect the lookup of the other options).  In addition,
  265. the \fB\-class\fR option may not be queried or changed using the
  266. \fBconfig\fR command described below.
  267.  
  268. .SH "WIDGET COMMAND"
  269. .PP
  270. The \fBframe\fR command creates a new Tcl command whose
  271. name is the same as the path name of the frame's window.  This
  272. command may be used to invoke various
  273. operations on the widget.  It has the following general form:
  274. .DS C
  275. \fIpathName option \fR?\fIarg arg ...\fR?
  276. .DE
  277. \fIPathName\fR is the name of the command, which is the same as
  278. the frame widget's path name.  \fIOption\fR and the \fIarg\fRs
  279. determine the exact behavior of the command.  The following
  280. commands are possible for frame widgets:
  281. .TP
  282. \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
  283. Query or modify the configuration options of the widget.
  284. If no \fIoption\fR is specified, returns a list describing all of
  285. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  286. information on the format of this list).  If \fIoption\fR is specified
  287. with no \fIvalue\fR, then the command returns a list describing the
  288. one named option (this list will be identical to the corresponding
  289. sublist of the value returned if no \fIoption\fR is specified).  If
  290. one or more \fIoption\-value\fR pairs are specified, then the command
  291. modifies the given widget option(s) to have the given value(s);  in
  292. this case the command returns an empty string.
  293. \fIOption\fR may have any of the values accepted by the \fBframe\fR
  294. command.
  295.  
  296. .SH BINDINGS
  297. .PP
  298. When a new frame is created, it has no default event bindings:
  299. frames are not intended to be interactive.
  300.  
  301. .SH KEYWORDS
  302. frame, widget
  303.